Api.RestartSlave method

Restarts the specified slave.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus RestartSlave(
       int SlaveId
)

Public Function RestartSlave(
       SlaveId As Integer
) As KsCommandStatus

Parameters

SlaveId

Type: int

The slave index. This index value is automatically assigned by the KINGSTAR master when the EtherCAT network starts, based on the physical connection order. The first device connected directly to the master is assigned Index 0, followed by Index 1, Index 2, and so on. These indexes remain consistent within the slave array even if devices are added, removed, or reconnected. Please refer to the use cases in HotConnect, Repair, and Restart for more details.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

If auto-repair is disabled, use this method to restart a slave after a cable is disconnected or if it has an EtherCAT error. Access to a slave will be blocked during restart, but it won't affect the applications as the slave will return to the normal state. Typically, this method is called when the slave is in the error state and its data is already unavailable.

Usable EtherCAT states

ecatOP

Examples

N/A